<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8"/>
<link rel="stylesheet" type="text/css" href="dmsstyle.css" />
<title>The dmrldap Schema</title>
</head>

<body>

  <div id="header"> <div class="headerBar"> </div> </div>

  <div id="main">

    <div id="content">

<!-- org.dmd.dms.doc.web.SchemaPage.writeSchemaSummary(SchemaPage.java:335) -->

  <div class="schemaName"> dmrldap </div>

  <div class="summary">

<!-- org.dmd.dms.doc.web.SchemaPage.writeClassSummary(SchemaPage.java:370) -->

    <div class="classList">
    <h2> Classes (4)</h2>
    <table>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#LDAPAttributeAUX"> LDAPAttributeAUX </a></td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#LDAPClassAUX"> LDAPClassAUX </a></td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#LDAPHierarchicObject"> LDAPHierarchicObject </a></td>
      <td> FQN </td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#LDAPSchemaAUX"> LDAPSchemaAUX </a></td>
      </tr>
    </table>
    </div>  </div> <!--  summary -->

<!-- org.dmd.dms.doc.web.SchemaPage.writeClasses(SchemaPage.java:202) -->

<div class="classDetails">

<h2> Class Details </h2>

<!-- org.dmd.dms.doc.web.ClassFormatter.dumpDetails(ClassFormatter.java:23) -->

  <table>

    <tr> <td class="className" colspan="4"> <a name="LDAPAttributeAUX"> LDAPAttributeAUX </a> </td></tr>
<!-- org.dmd.dms.doc.web.ClassFormatter.description(ClassFormatter.java:54) -->

    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The LDAPSchemaExtension class is used to extend the basic SchemaDefinition
 class with information required to map objects onto an LDAP repository.</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.type(ClassFormatter.java:65) -->

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">AUXILIARY</td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td colspan="5"class="attributeSectionLabel">May have attributes</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.appendAttribute(ClassFormatter.java:200) -->

    <tr>
      <td class="spacer"> </td>
      <td> <a href="dmrldap.html#reposName">reposName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> This attribute indicates the name of an attribute or class when
 it is stored in a repository and added to that repository's schema. Generally
 speaking, we will always use the standard prefix for all attribute and class
 names. Like all other name values, this one must be globally unique.      </td>
    </tr>

  </table>

<!-- org.dmd.dms.doc.web.ClassFormatter.dumpDetails(ClassFormatter.java:23) -->

  <table>

    <tr> <td class="className" colspan="4"> <a name="LDAPClassAUX"> LDAPClassAUX </a> </td></tr>
<!-- org.dmd.dms.doc.web.ClassFormatter.description(ClassFormatter.java:54) -->

    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The LDAPSchemaExtension class is used to extend the basic SchemaDefinition
 class with information required to map objects onto an LDAP repository.</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.type(ClassFormatter.java:65) -->

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">AUXILIARY</td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td colspan="5"class="attributeSectionLabel">May have attributes</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.appendAttribute(ClassFormatter.java:200) -->

    <tr>
      <td class="spacer"> </td>
      <td> <a href="meta.html#namingAttribute">namingAttribute</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#AttributeDefinition">AttributeDefinition</a> </td>
      <td> This attribute indicates the attribute that is used to name an object
 instance. The exact manner in which the naming attribute is used is specific to
 the implementation of the HierarchicObject derived class.
 <p>
 For instance, the DotNamedObject simply uses the value of the naming attribute
 and separates the attribute values with periods e.g. grandparent.parent.child.
 <p>
 For LDAP objects when a hierarchic name is composed for an object, the class name
 plus the value of the naming attribute (type:value) is used to create the
 name of an object. It is best if the naming attribute value is created by
 the application; it shouldn't be based on any user configurable value.      </td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.appendAttribute(ClassFormatter.java:200) -->

    <tr>
      <td class="spacer"> </td>
      <td> <a href="dmrldap.html#reposName">reposName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> This attribute indicates the name of an attribute or class when
 it is stored in a repository and added to that repository's schema. Generally
 speaking, we will always use the standard prefix for all attribute and class
 names. Like all other name values, this one must be globally unique.      </td>
    </tr>

  </table>

<!-- org.dmd.dms.doc.web.ClassFormatter.dumpDetails(ClassFormatter.java:23) -->

  <table>

    <tr> <td class="className" colspan="4"> <a name="LDAPHierarchicObject"> LDAPHierarchicObject </a> </td></tr>
<!-- org.dmd.dms.doc.web.ClassFormatter.description(ClassFormatter.java:54) -->

    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The LDAPHierarchicObject provides some additional structure and
 conventions to the HierarchicObject to make it usable in conjunction with an LDAP
 enabled directory server. Classes derived from LDAPHierarchicObject must be defined
 in a schema that has been extended with the LDAPSchemaExtension auxiliary class and
 must themselves be extended with the LDAPClassExtension auxiliary class; the class
 must have a defined naming attribute. Furthermore, naming attributes should be
 unique for each defined class.</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.type(ClassFormatter.java:65) -->

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">STRUCTURAL</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.derivedFrom(ClassFormatter.java:79) -->

    <tr>
      <td class="spacer"> </td>
      <td>Derived from</td>
      <td colspan="2">
      <a href="dmrbase.html#HierarchicObject">HierarchicObject</a>
      </td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.wrapper(ClassFormatter.java:137) -->

    <tr>
      <td class="spacer"> </td>
      <td>Wrapper</td>
      <td colspan="2">EXTENDED</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.namedBy(ClassFormatter.java:151) -->

    <tr>
      <td class="spacer"> </td>
      <td>Named by</td>
      <td colspan="2"> <a href="meta.html#FQN">FQN</a> </td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td colspan="5"class="attributeSectionLabel">Must have attributes</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.appendAttribute(ClassFormatter.java:200) -->

    <tr>
      <td class="spacer"> </td>
      <td> <a href="meta.html#FQN">FQN</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#FullyQualifiedName">FullyQualifiedName</a> </td>
      <td> The fully qualified name of a hierarchic object. The exact form of
 the fqn is application specific.      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td colspan="5"class="attributeSectionLabel">Internal use attributes</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.appendAttribute(ClassFormatter.java:200) -->

    <tr>
      <td class="spacer"> </td>
      <td> <a href="meta.html#file">file</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> Indicates the file from which a definition was loaded.      </td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.appendAttribute(ClassFormatter.java:200) -->

    <tr>
      <td class="spacer"> </td>
      <td> <a href="meta.html#lineNumber">lineNumber</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#Integer">Integer</a> </td>
      <td> Indicates the line number of the file from which a definition was loaded.      </td>
    </tr>

  </table>

<!-- org.dmd.dms.doc.web.ClassFormatter.dumpDetails(ClassFormatter.java:23) -->

  <table>

    <tr> <td class="className" colspan="4"> <a name="LDAPSchemaAUX"> LDAPSchemaAUX </a> </td></tr>
<!-- org.dmd.dms.doc.web.ClassFormatter.description(ClassFormatter.java:54) -->

    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The LDAPSchemaExtension class is used to extend the basic SchemaDefinition
 class with information required to map objects onto an LDAP repository.</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.type(ClassFormatter.java:65) -->

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">AUXILIARY</td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td colspan="5"class="attributeSectionLabel">May have attributes</td>
    </tr>

<!-- org.dmd.dms.doc.web.ClassFormatter.appendAttribute(ClassFormatter.java:200) -->

    <tr>
      <td class="spacer"> </td>
      <td> <a href="dmrldap.html#ldapIdPrefix">ldapIdPrefix</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> The ldapIdPrefix is defined for use against an entire schema. It
 indicates the prefix that will be added to all class and attribute definitions
 that are loaded into the directory as schema. Having a prefix prevents possible
 collisions with existing schema definitions. The prefix should be short, 2 or 3
 characters.      </td>
    </tr>

  </table>

</div> <!-- classDetails -->

<!-- org.dmd.dms.doc.web.SchemaPage.writeAttributes(SchemaPage.java:222) -->

<div class="attributeDetails">

<h2> Attribute Details </h2>

  <table>

<!-- org.dmd.dms.doc.web.AttributeFormatter.dumpDetails(AttributeFormatter.java:21) -->
    <tr> <td class="className" colspan="3"> <a name="ldapIdPrefix"> ldapIdPrefix </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#String">String</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The ldapIdPrefix is defined for use against an entire schema. It\n indicates the prefix that will be added to all class and attribute definitions\n that are loaded into the directory as schema. Having a prefix prevents possible\n collisions with existing schema definitions. The prefix should be short, 2 or 3\n characters.<p/>
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Used in:</td>
      <td>
        <table>
        <tr>
          <td> LDAPSchemaAUX (<a href="dmrldap.html#LDAPSchemaAUX">dmrldap</a>) </td>
        </tr>
        </table>
      </td>
    </tr>

<!-- org.dmd.dms.doc.web.AttributeFormatter.dumpDetails(AttributeFormatter.java:21) -->
    <tr> <td class="className" colspan="3"> <a name="reposName"> reposName </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#String">String</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>This attribute indicates the name of an attribute or class when\n it is stored in a repository and added to that repository's schema. Generally\n speaking, we will always use the standard prefix for all attribute and class\n names. Like all other name values, this one must be globally unique.<p/>
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Used in:</td>
      <td>
        <table>
        <tr>
          <td> LDAPAttributeAUX (<a href="dmrldap.html#LDAPAttributeAUX">dmrldap</a>) </td>
          <td> LDAPClassAUX (<a href="dmrldap.html#LDAPClassAUX">dmrldap</a>) </td>
        </tr>
        </table>
      </td>
    </tr>

  </table>

</div> <!-- attributeDetails -->

    </div>

<!-- org.dmd.dms.doc.web.Summarizer.buildSidebar(Summarizer.java:98) -->
    <div id="sidebar">
        <a class="navLink" href="contacts.html"> contacts</a>
        <a class="navLink" href="dmrbase.html"> dmrbase</a>
        <a class="navLink" href="dmrldap.html"> dmrldap</a>
        <a class="navLink" href="meta.html"> meta</a>
        <a class="navLink" href="SchemaSummaryPage.html"> Summary </a>
    </div>
  </div> <!-- main -->

  <div id="footer"> </div>

</body>

</html>
